Skip to content

Add new option to database analyze tutorial#7056

Merged
jf205 merged 7 commits into
github:mainfrom
jf205:sarif-query-help
Nov 9, 2021
Merged

Add new option to database analyze tutorial#7056
jf205 merged 7 commits into
github:mainfrom
jf205:sarif-query-help

Conversation

@jf205

@jf205 jf205 commented Nov 4, 2021

Copy link
Copy Markdown
Contributor

In the upcoming release of the CodeQL CLI there's a new option you can supply to the database analyze command to include query help files for custom queries in the SARIF file produced during the analysis. The query help must be in markdown, not .qhelp format. There'll be an accompanying change in the GitHub docs to briefly mention how to enable this feature for users running CodeQL code scanning on 3rd party CI/CD systems. However, much of new information is aimed at custom query writers so the bulk of the detail is in this PR.

@jf205 jf205 marked this pull request as ready for review November 4, 2021 14:59
@jf205

jf205 commented Nov 8, 2021

Copy link
Copy Markdown
Contributor Author

BONUS: In https://codeql.github.com/docs/writing-codeql-queries/debugging-data-flow-queries-using-partial-flow/ I spotted a weird empty code block and am incorrectly rendered link. Fixed in dfe77f8.

@jf205 jf205 added the ready-for-doc-review This PR requires and is ready for review from the GitHub docs team. label Nov 8, 2021
@jf205

jf205 commented Nov 8, 2021

Copy link
Copy Markdown
Contributor Author

@adityasharad: please can I get a quick technical review?

@jf205 jf205 requested a review from adityasharad November 8, 2021 14:27

@ethanpalm ethanpalm left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good from a docs point of view 👍🏼

@jf205 jf205 merged commit 1bacce4 into github:main Nov 9, 2021
@jf205 jf205 deleted the sarif-query-help branch November 9, 2021 10:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation ready-for-doc-review This PR requires and is ready for review from the GitHub docs team.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants